Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix android input focus in the search router component #51064

Conversation

abzokhattab
Copy link
Contributor

Details

Fixed Issues

$ #51010
PROPOSAL: #51010 (comment)

Tests

  • Verify that no errors appear in the JS console
  1. Launch New Expensify app.
  2. Open a report.
  3. Tap Search icon.
  4. validate that the search input text is focused and the keyboard shows up automtically

Offline tests

Same as tests

QA Steps

Same as tests

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
    • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
    • MacOS: Desktop
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
    • I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

Android: Native
WhatsApp.Video.2024-10-17.at.11.03.31.PM.mp4
Android: mWeb Chrome
WhatsApp.Video.2024-10-17.at.11.03.31.PM.2.mp4
iOS: Native
WhatsApp.Video.2024-10-17.at.11.03.29.PM.mp4
iOS: mWeb Safari
WhatsApp.Video.2024-10-17.at.11.03.31.PM.1.mp4
MacOS: Chrome / Safari
WhatsApp.Video.2024-10-17.at.11.03.31.PM.4.mp4
MacOS: Desktop
WhatsApp.Video.2024-10-17.at.11.03.31.PM.3.mp4

@abzokhattab abzokhattab requested a review from a team as a code owner October 17, 2024 21:31
@melvin-bot melvin-bot bot requested review from jayeshmangwani and removed request for a team October 17, 2024 21:31
Copy link

melvin-bot bot commented Oct 17, 2024

@jayeshmangwani Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

@jayeshmangwani
Copy link
Contributor

jayeshmangwani commented Oct 17, 2024

Reviewer Checklist

  • I have verified the author checklist is complete (all boxes are checked off).
  • I verified the correct issue is linked in the ### Fixed Issues section above
  • I verified testing steps are clear and they cover the changes made in this PR
    • I verified the steps for local testing are in the Tests section
    • I verified the steps for Staging and/or Production testing are in the QA steps section
    • I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
  • I checked that screenshots or videos are included for tests on all platforms
  • I included screenshots or videos for tests on all platforms
  • I verified tests pass on all platforms & I tested again on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
    • MacOS: Desktop
  • If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
  • I verified proper code patterns were followed (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
    • I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I verified that this PR follows the guidelines as stated in the Review Guidelines
  • I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
  • If a new component is created I verified that:
    • A similar component doesn't exist in the codebase
    • All props are defined accurately and each prop has a /** comment above it */
    • The file is named correctly
    • The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • The only data being stored in the state is data necessary for rendering and nothing else
    • For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
    • Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
    • All JSX used for rendering exists in the render method
    • The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native
Android.mp4
Android.mov
Android: mWeb Chrome
mweb-chrome.mp4
mweb-chrome.mov
iOS: Native
iOS.mov
ios.mov
iOS: mWeb Safari
mweb-safari.mov
mweb-safari.mov
MacOS: Chrome / Safari
web.mov
MacOS: Desktop
desktop.mov

@jayeshmangwani
Copy link
Contributor

@luacmartins @srikarparsi Keyboard isn't opening in iOS mobile Safari, and I think that's a known issue since it's not working in many places at the moment. Otherwise, the changes look good, and other platforms are working well.

@melvin-bot melvin-bot bot requested a review from srikarparsi October 17, 2024 22:07
@luacmartins
Copy link
Contributor

Keyboard isn't opening in iOS mobile Safari

hmm the current staging build seems to open the keyboard on my physical device

@luacmartins
Copy link
Contributor

perf tests are failing 😞

@abzokhattab
Copy link
Contributor Author

Keyboard isn't opening in iOS mobile Safari

is this happening on specific ios versions or devices?

for me its also opening as shown in the attached screenshot

@jayeshmangwani
Copy link
Contributor

is this happening on specific ios versions or devices?

iphone SE(3rd gen) , 17.5 version

@jayeshmangwani
Copy link
Contributor

Let me test it on a few other simulators

@abzokhattab
Copy link
Contributor Author

abzokhattab commented Oct 17, 2024

Just tested on ios-safari with iphone SE(3rd gen) - 17.5 and its behaving as expected 🤔

Screen.Recording.2024-10-18.at.00.32.47.mov

@jayeshmangwani
Copy link
Contributor

Tested with two simulators, and I'm seeing the same issue on my side—the keyboard hides. However, when I use the main branch, the keyboard opens. It looks like we're breaking mobile Safari with these changes.

@jayeshmangwani
Copy link
Contributor

Strange simulator behavior. Should we test with an ad-hoc build here @luacmartins ?

@srikarparsi
Copy link
Contributor

srikarparsi commented Oct 17, 2024

Yeah I can trigger an ad-hoc build, but if it's working on main but not the branch for the same simulator might be a code problem - but it is working in @abzokhattab's screenshot which is weird.

@luacmartins
Copy link
Contributor

luacmartins commented Oct 17, 2024

Running adhoc build here. Let's test it as soon as the web build is done so we don't wait for iOS/android?

@jayeshmangwani
Copy link
Contributor

Let's test it as soon as the web build is done so we don't wait for iOS/android?

Yes 👍

@jayeshmangwani
Copy link
Contributor

@luacmartins @abzokhattab @srikarparsi Tested with the physical device and keyboard doesn't open for mweb safari 😞

@abzokhattab
Copy link
Contributor Author

abzokhattab commented Oct 17, 2024

I think that's a known issue since it's not working in many places at the moment

Going back to this point, do you know if there is an issue that covers this bug in MWeb/Safari? it would be useful if we can get more context

@jayeshmangwani
Copy link
Contributor

#10414

@jayeshmangwani
Copy link
Contributor

PR and staging comparison

RPReplay_Final1729205398.mov

This comment has been minimized.

@abzokhattab
Copy link
Contributor Author

abzokhattab commented Oct 17, 2024

I am able to reproduce it now on the physical device... also the same issue occurs with the new chat input ... we might have some other components that have the same issue

WhatsApp.Video.2024-10-18.at.1.11.06.AM.mp4

@abzokhattab
Copy link
Contributor Author

abzokhattab commented Oct 17, 2024

More context:

necolas/react-native-web#2175 (comment)

Click event means user is interacting. But because "focus trap" will refocus, the keyboard opened by a direct call to focus() will be closed.
If we use setTimeout to delay the call to focus() , the user interaction context will be lost. Keyboard still won't open.

seems like the timeout causes the keyboard not to open up on ios/safari. since ios safari is already working on staging, should i change my implementation to use shouldDelayFocus instead of the useAutoFocusInput and make it as false if the current platform is ios safari ?

what do you think about this plan?

@jayeshmangwani
Copy link
Contributor

use shouldDelayFocus instead of the useAutoFocusInput and make it as false if the current platform is ios safari ?

What if we remove useAutoFocusInput and instead use autoFocus, passing shouldDelayFocus along with it? The value for shouldDelayFocus will come from src/libs/shouldDelayFocus/index.ts, and it will only delay on Android. What do you think?

@abzokhattab
Copy link
Contributor Author

I agree

Optionally for the future we can fix it globally by changing this condition to if (shouldDelayFocus && !Browser.isSafari()) or we can use the shouldDelayFocus from the src/libs/shouldDelayFocus/index.ts file instead of the !Browser.isSafari check

if (shouldDelayFocus) {
const focusTimeout = setTimeout(() => input?.current?.focus(), CONST.ANIMATED_TRANSITION);
return () => clearTimeout(focusTimeout);
}

But for now i will fix the current issue

@jayeshmangwani
Copy link
Contributor

But for now i will fix the current issue

Sounds like a good plan. We can start the Slack discussion about it, but for now, let's focus on this issue 😄

@abzokhattab
Copy link
Contributor Author

Done i have done another round of testing and all devices are working as expected.

Can you please check the mweb/safari sepecifcally from your side

@srikarparsi
Copy link
Contributor

Also started another adhoc build in case we need it

@jayeshmangwani
Copy link
Contributor

Can you please check the mweb/safari sepecifcally from your side

Tested mweb and its working fine

@abzokhattab
Copy link
Contributor Author

test passed using the build on my physical device.

Copy link
Contributor

@srikarparsi srikarparsi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool, this looks good to me, thanks for the changes @abzokhattab and @jayeshmangwani. @luacmartins are you around to take a second look at this, if not we can merge.

Copy link
Contributor

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖 iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/51064/index.html ❌ FAILED ❌
Android The QR code can't be generated, because the iOS build failed
Desktop 💻 Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/51064/NewExpensify.dmg https://51064.pr-testing.expensify.com
Desktop Web

👀 View the workflow run that generated this build 👀

@srikarparsi
Copy link
Contributor

Going to go ahead and merge so we can clear the deploy blocker

@srikarparsi srikarparsi merged commit f180cbb into Expensify:main Oct 18, 2024
16 checks passed
@OSBotify
Copy link
Contributor

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

OSBotify pushed a commit that referenced this pull request Oct 18, 2024
…h-router-input

Fix android input focus in the search router component

(cherry picked from commit f180cbb)

(CP triggered by marcaaron)
@github-actions github-actions bot added the CP Staging marks PRs that have been CP'd to staging label Oct 18, 2024
Copy link
Contributor

🚀 Cherry-picked to staging by https://github.com/marcaaron in version: 9.0.50-7 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 failure ❌
🕸 web 🕸 success ✅

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

1 similar comment
Copy link
Contributor

🚀 Cherry-picked to staging by https://github.com/marcaaron in version: 9.0.50-7 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 failure ❌
🕸 web 🕸 success ✅

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

@srikarparsi
Copy link
Contributor

Hm, the iOS build failed on the AdHoc build and both the cherry pick builds. @jayeshmangwani and @abzokhattab were you able to test the latest changes on iOS?

@jayeshmangwani
Copy link
Contributor

@srikarparsi I've tested the iOS build locally, and it worked fine. I'm not sure how to test the staging iOS build.

Copy link
Contributor

🚀 Cherry-picked to staging by https://github.com/marcaaron in version: 9.0.50-7 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 failure ❌
🕸 web 🕸 success ✅

@Expensify/applauseleads please QA this PR and check it off on the deploy checklist if it passes.

Copy link
Contributor

🚀 Deployed to production by https://github.com/marcaaron in version: 9.0.50-8 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CP Staging marks PRs that have been CP'd to staging Ready To Build
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants